home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.2 Development Libraries / SGI IRIX 6.2 Development Libraries.iso / dist / sgitcl_dev.idb / usr / sgitcl / include / tclInt.h.z / tclInt.h
C/C++ Source or Header  |  1996-03-14  |  36KB  |  933 lines
  1. /*
  2.  * tclInt.h --
  3.  *
  4.  *    Declarations of things used internally by the Tcl interpreter.
  5.  *
  6.  * Copyright (c) 1987-1993 The Regents of the University of California.
  7.  * Copyright (c) 1994-1995 Sun Microsystems, Inc.
  8.  *
  9.  * See the file "license.terms" for information on usage and redistribution
  10.  * of this file, and for a DISCLAIMER OF ALL WARRANTIES.
  11.  *
  12.  * @(#) tclInt.h 1.105 95/06/28 09:36:23
  13.  */
  14.  
  15. #ifndef _TCLINT
  16. #define _TCLINT
  17.  
  18. /*
  19.  * Common include files needed by most of the Tcl source files are
  20.  * included here, so that system-dependent personalizations for the
  21.  * include files only have to be made in once place.  This results
  22.  * in a few extra includes, but greater modularity.  The order of
  23.  * the three groups of #includes is important.  For example, stdio.h
  24.  * is needed by tcl.h, and the _ANSI_ARGS_ declaration in tcl.h is
  25.  * needed by stdlib.h in some configurations.
  26.  */
  27.  
  28. #include <stdio.h>
  29.  
  30. #ifndef _TCL
  31. #include "tcl.h"
  32. #endif
  33. #ifndef _REGEXP
  34. #include "tclRegexp.h"
  35. #endif
  36.  
  37. #include <ctype.h>
  38. #ifdef NO_LIMITS_H
  39. #   include "compat/limits.h"
  40. #else
  41. #   include <limits.h>
  42. #endif
  43. #ifdef NO_STDLIB_H
  44. #   include "compat/stdlib.h"
  45. #else
  46. #   include <stdlib.h>
  47. #endif
  48. #ifdef NO_STRING_H
  49. #include "compat/string.h"
  50. #else
  51. #include <string.h>
  52. #endif
  53. #include <varargs.h>
  54.  
  55. /*
  56.  * At present (12/91) not all stdlib.h implementations declare strtod.
  57.  * The declaration below is here to ensure that it's declared, so that
  58.  * the compiler won't take the default approach of assuming it returns
  59.  * an int.  There's no ANSI prototype for it because there would end
  60.  * up being too many conflicts with slightly-different prototypes.
  61.  */
  62.  
  63. extern double strtod();
  64.  
  65. /*
  66.  *----------------------------------------------------------------
  67.  * Data structures related to variables.   These are used primarily
  68.  * in tclVar.c
  69.  *----------------------------------------------------------------
  70.  */
  71.  
  72. /*
  73.  * The following structure defines a variable trace, which is used to
  74.  * invoke a specific C procedure whenever certain operations are performed
  75.  * on a variable.
  76.  */
  77.  
  78. typedef struct VarTrace {
  79.     Tcl_VarTraceProc *traceProc;/* Procedure to call when operations given
  80.                  * by flags are performed on variable. */
  81.     ClientData clientData;    /* Argument to pass to proc. */
  82.     int flags;            /* What events the trace procedure is
  83.                  * interested in:  OR-ed combination of
  84.                  * TCL_TRACE_READS, TCL_TRACE_WRITES, and
  85.                  * TCL_TRACE_UNSETS. */
  86.     struct VarTrace *nextPtr;    /* Next in list of traces associated with
  87.                  * a particular variable. */
  88. } VarTrace;
  89.  
  90. /*
  91.  * When a variable trace is active (i.e. its associated procedure is
  92.  * executing), one of the following structures is linked into a list
  93.  * associated with the variable's interpreter.  The information in
  94.  * the structure is needed in order for Tcl to behave reasonably
  95.  * if traces are deleted while traces are active.
  96.  */
  97.  
  98. typedef struct ActiveVarTrace {
  99.     struct Var *varPtr;        /* Variable that's being traced. */
  100.     struct ActiveVarTrace *nextPtr;
  101.                 /* Next in list of all active variable
  102.                  * traces for the interpreter, or NULL
  103.                  * if no more. */
  104.     VarTrace *nextTracePtr;    /* Next trace to check after current
  105.                  * trace procedure returns;  if this
  106.                  * trace gets deleted, must update pointer
  107.                  * to avoid using free'd memory. */
  108. } ActiveVarTrace;
  109.  
  110. /*
  111.  * The following structure describes an enumerative search in progress on
  112.  * an array variable;  this are invoked with options to the "array"
  113.  * command.
  114.  */
  115.  
  116. typedef struct ArraySearch {
  117.     int id;            /* Integer id used to distinguish among
  118.                  * multiple concurrent searches for the
  119.                  * same array. */
  120.     struct Var *varPtr;        /* Pointer to array variable that's being
  121.                  * searched. */
  122.     Tcl_HashSearch search;    /* Info kept by the hash module about
  123.                  * progress through the array. */
  124.     Tcl_HashEntry *nextEntry;    /* Non-null means this is the next element
  125.                  * to be enumerated (it's leftover from
  126.                  * the Tcl_FirstHashEntry call or from
  127.                  * an "array anymore" command).  NULL
  128.                  * means must call Tcl_NextHashEntry
  129.                  * to get value to return. */
  130.     struct ArraySearch *nextPtr;/* Next in list of all active searches
  131.                  * for this variable, or NULL if this is
  132.                  * the last one. */
  133. } ArraySearch;
  134.  
  135. /*
  136.  * The structure below defines a variable, which associates a string name
  137.  * with a string value.  Pointers to these structures are kept as the
  138.  * values of hash table entries, and the name of each variable is stored
  139.  * in the hash entry.
  140.  */
  141.  
  142. typedef struct Var {
  143.     int valueLength;        /* Holds the number of non-null bytes
  144.                  * actually occupied by the variable's
  145.                  * current value in value.string (extra
  146.                  * space is sometimes left for expansion).
  147.                  * For array and global variables this is
  148.                  * meaningless. */
  149.     int valueSpace;        /* Total number of bytes of space allocated
  150.                  * at value.string.  0 means there is no
  151.                  * space allocated. */
  152.     union {
  153.     char *string;        /* String value of variable, used for scalar
  154.                  * variables and array elements.  Malloc-ed. */
  155.     Tcl_HashTable *tablePtr;/* For array variables, this points to
  156.                  * information about the hash table used
  157.                  * to implement the associative array. 
  158.                  * Points to malloc-ed data. */
  159.     struct Var *upvarPtr;    /* If this is a global variable being
  160.                  * referred to in a procedure, or a variable
  161.                  * created by "upvar", this field points to
  162.                  * the record for the higher-level variable. */
  163.     } value;
  164.     Tcl_HashEntry *hPtr;    /* Hash table entry that refers to this
  165.                  * variable, or NULL if the variable has
  166.                  * been detached from its hash table (e.g.
  167.                  * an array is deleted, but some of its
  168.                  * elements are still referred to in upvars). */
  169.     int refCount;        /* Counts number of active uses of this
  170.                  * variable, not including its main hash
  171.                  * table entry: 1 for each additional variable
  172.                  * whose upVarPtr points here, 1 for each
  173.                  * nested trace active on variable.  This
  174.                  * record can't be deleted until refCount
  175.                  * becomes 0. */
  176.     VarTrace *tracePtr;        /* First in list of all traces set for this
  177.                  * variable. */
  178.     ArraySearch *searchPtr;    /* First in list of all searches active
  179.                  * for this variable, or NULL if none. */
  180.     int flags;            /* Miscellaneous bits of information about
  181.                  * variable.  See below for definitions. */
  182. } Var;
  183.  
  184. /*
  185.  * Flag bits for variables:
  186.  *
  187.  * VAR_ARRAY    -        1 means this is an array variable rather
  188.  *                than a scalar variable.
  189.  * VAR_UPVAR -             1 means this variable just contains a
  190.  *                pointer to another variable that has the
  191.  *                real value.  Variables like this come
  192.  *                about through the "upvar" and "global"
  193.  *                commands.
  194.  * VAR_UNDEFINED -        1 means that the variable is currently
  195.  *                undefined.  Undefined variables usually
  196.  *                go away completely, but if an undefined
  197.  *                variable has a trace on it, or if it is
  198.  *                a global variable being used by a procedure,
  199.  *                then it stays around even when undefined.
  200.  * VAR_TRACE_ACTIVE -        1 means that trace processing is currently
  201.  *                underway for a read or write access, so
  202.  *                new read or write accesses should not cause
  203.  *                trace procedures to be called and the
  204.  *                variable can't be deleted.
  205.  */
  206.  
  207. #define VAR_ARRAY        1
  208. #define VAR_UPVAR        2
  209. #define VAR_UNDEFINED        4
  210. #define VAR_TRACE_ACTIVE    0x10
  211.  
  212. /*
  213.  *----------------------------------------------------------------
  214.  * Data structures related to procedures.   These are used primarily
  215.  * in tclProc.c
  216.  *----------------------------------------------------------------
  217.  */
  218.  
  219. /*
  220.  * The structure below defines an argument to a procedure, which
  221.  * consists of a name and an (optional) default value.
  222.  */
  223.  
  224. typedef struct Arg {
  225.     struct Arg *nextPtr;    /* Next argument for this procedure,
  226.                  * or NULL if this is the last argument. */
  227.     char *defValue;        /* Pointer to arg's default value, or NULL
  228.                  * if no default value. */
  229.     char name[4];        /* Name of argument starts here.  The name
  230.                  * is followed by space for the default,
  231.                  * if there is one.  The actual size of this
  232.                  * field will be as large as necessary to
  233.                  * hold both name and default value.  THIS
  234.                  * MUST BE THE LAST FIELD IN THE STRUCTURE!! */
  235. } Arg;
  236.  
  237. /*
  238.  * The structure below defines a command procedure, which consists of
  239.  * a collection of Tcl commands plus information about arguments and
  240.  * variables.
  241.  */
  242.  
  243. typedef struct Proc {
  244.     struct Interp *iPtr;    /* Interpreter for which this command
  245.                  * is defined. */
  246.     int refCount;        /* Reference count:  1 if still present
  247.                  * in command table plus 1 for each call
  248.                  * to the procedure that is currently
  249.                  * active.  This structure can be freed
  250.                  * when refCount becomes zero. */
  251.     char *command;        /* Command that constitutes the body of
  252.                  * the procedure (dynamically allocated). */
  253.     Arg *argPtr;        /* Pointer to first of procedure's formal
  254.                  * arguments, or NULL if none. */
  255. } Proc;
  256.  
  257. /*
  258.  * The structure below defines a command trace.  This is used to allow Tcl
  259.  * clients to find out whenever a command is about to be executed.
  260.  */
  261.  
  262. typedef struct Trace {
  263.     int level;            /* Only trace commands at nesting level
  264.                  * less than or equal to this. */
  265.     Tcl_CmdTraceProc *proc;    /* Procedure to call to trace command. */
  266.     ClientData clientData;    /* Arbitrary value to pass to proc. */
  267.     struct Trace *nextPtr;    /* Next in list of traces for this interp. */
  268. } Trace;
  269.  
  270. /*
  271.  * The stucture below defines a deletion callback, which is
  272.  * a procedure to invoke just before an interpreter is deleted.
  273.  */
  274.  
  275. typedef struct DeleteCallback {
  276.     Tcl_InterpDeleteProc *proc;    /* Procedure to call. */
  277.     ClientData clientData;    /* Value to pass to procedure. */
  278.     struct DeleteCallback *nextPtr;
  279.                 /* Next in list of callbacks for this
  280.                  * interpreter (or NULL for end of list). */
  281. } DeleteCallback;
  282.  
  283. /*
  284.  * The structure below defines a frame, which is a procedure invocation.
  285.  * These structures exist only while procedures are being executed, and
  286.  * provide a sort of call stack.
  287.  */
  288.  
  289. typedef struct CallFrame {
  290.     Tcl_HashTable varTable;    /* Hash table containing all of procedure's
  291.                  * local variables. */
  292.     int level;            /* Level of this procedure, for "uplevel"
  293.                  * purposes (i.e. corresponds to nesting of
  294.                  * callerVarPtr's, not callerPtr's).  1 means
  295.                  * outer-most procedure, 0 means top-level. */
  296.     int argc;            /* This and argv below describe name and
  297.                  * arguments for this procedure invocation. */
  298.     char **argv;        /* Array of arguments. */
  299.     struct CallFrame *callerPtr;
  300.                 /* Value of interp->framePtr when this
  301.                  * procedure was invoked (i.e. next in
  302.                  * stack of all active procedures). */
  303.     struct CallFrame *callerVarPtr;
  304.                 /* Value of interp->varFramePtr when this
  305.                  * procedure was invoked (i.e. determines
  306.                  * variable scoping within caller;  same
  307.                  * as callerPtr unless an "uplevel" command
  308.                  * or something equivalent was active in
  309.                  * the caller). */
  310. } CallFrame;
  311.  
  312. /*
  313.  * The structure below defines one history event (a previously-executed
  314.  * command that can be re-executed in whole or in part).
  315.  */
  316.  
  317. typedef struct {
  318.     char *command;        /* String containing previously-executed
  319.                  * command. */
  320.     int bytesAvl;        /* Total # of bytes available at *event (not
  321.                  * all are necessarily in use now). */
  322. } HistoryEvent;
  323.  
  324. /*
  325.  *----------------------------------------------------------------
  326.  * Data structures related to history.   These are used primarily
  327.  * in tclHistory.c
  328.  *----------------------------------------------------------------
  329.  */
  330.  
  331. /*
  332.  * The structure below defines a pending revision to the most recent
  333.  * history event.  Changes are linked together into a list and applied
  334.  * during the next call to Tcl_RecordHistory.  See the comments at the
  335.  * beginning of tclHistory.c for information on revisions.
  336.  */
  337.  
  338. typedef struct HistoryRev {
  339.     int firstIndex;        /* Index of the first byte to replace in
  340.                  * current history event. */
  341.     int lastIndex;        /* Index of last byte to replace in
  342.                  * current history event. */
  343.     int newSize;        /* Number of bytes in newBytes. */
  344.     char *newBytes;        /* Replacement for the range given by
  345.                  * firstIndex and lastIndex (malloced). */
  346.     struct HistoryRev *nextPtr;    /* Next in chain of revisions to apply, or
  347.                  * NULL for end of list. */
  348. } HistoryRev;
  349.  
  350. /*
  351.  *----------------------------------------------------------------
  352.  * Data structures related to files.  These are used primarily in
  353.  * tclUnixUtil.c and tclUnixAZ.c.
  354.  *----------------------------------------------------------------
  355.  */
  356.  
  357. /*
  358.  * The data structure below defines an open file (or connection to
  359.  * a process pipeline) as returned by the "open" command.
  360.  */
  361.  
  362. typedef struct OpenFile {
  363.     FILE *f;            /* Stdio file to use for reading and/or
  364.                  * writing. */
  365.     FILE *f2;            /* Normally NULL.  In the special case of
  366.                  * a command pipeline with pipes for both
  367.                  * input and output, this is a stdio file
  368.                  * to use for writing to the pipeline. */
  369.     int permissions;        /* OR-ed combination of TCL_FILE_READABLE
  370.                  * and TCL_FILE_WRITABLE. */
  371.     int numPids;        /* If this is a connection to a process
  372.                  * pipeline, gives number of processes
  373.                  * in pidPtr array below;  otherwise it
  374.                  * is 0. */
  375.     int *pidPtr;        /* Pointer to malloc-ed array of child
  376.                  * process ids (numPids of them), or NULL
  377.                  * if this isn't a connection to a process
  378.                  * pipeline. */
  379.     int errorId;        /* File id of file that receives error
  380.                  * output from pipeline.  -1 means not
  381.                  * used (i.e. this is a normal file). */
  382. } OpenFile;
  383.  
  384. /*
  385.  *----------------------------------------------------------------
  386.  * Data structures related to expressions.  These are used only in
  387.  * tclExpr.c.
  388.  *----------------------------------------------------------------
  389.  */
  390.  
  391. /*
  392.  * The data structure below defines a math function (e.g. sin or hypot)
  393.  * for use in Tcl expressions.
  394.  */
  395.  
  396. #define MAX_MATH_ARGS 5
  397. typedef struct MathFunc {
  398.     int numArgs;        /* Number of arguments for function. */
  399.     Tcl_ValueType argTypes[MAX_MATH_ARGS];
  400.                 /* Acceptable types for each argument. */
  401.     Tcl_MathProc *proc;        /* Procedure that implements this function. */
  402.     ClientData clientData;    /* Additional argument to pass to the function
  403.                  * when invoking it. */
  404. } MathFunc;
  405.  
  406. /*
  407.  *----------------------------------------------------------------
  408.  * One of the following structures exists for each command in
  409.  * an interpreter.  The Tcl_Command opaque type actually refers
  410.  * to these structures.
  411.  *----------------------------------------------------------------
  412.  */
  413.  
  414. typedef struct Command {
  415.     Tcl_HashEntry *hPtr;    /* Pointer to the hash table entry in
  416.                  * interp->commandTable that refers to
  417.                  * this command.  Used to get a command's
  418.                  * name from its Tcl_Command handle. */
  419.     Tcl_CmdProc *proc;        /* Procedure to process command. */
  420.     ClientData clientData;    /* Arbitrary value to pass to proc. */
  421.     Tcl_CmdDeleteProc *deleteProc;
  422.                 /* Procedure to invoke when deleting
  423.                  * command. */
  424.     ClientData deleteData;    /* Arbitrary value to pass to deleteProc
  425.                  * (usually the same as clientData). */
  426. } Command;
  427.  
  428. /*
  429.  *----------------------------------------------------------------
  430.  * This structure defines an interpreter, which is a collection of
  431.  * commands plus other state information related to interpreting
  432.  * commands, such as variable storage.  Primary responsibility for
  433.  * this data structure is in tclBasic.c, but almost every Tcl
  434.  * source file uses something in here.
  435.  *----------------------------------------------------------------
  436.  */
  437.  
  438. typedef struct Interp {
  439.  
  440.     /*
  441.      * Note:  the first three fields must match exactly the fields in
  442.      * a Tcl_Interp struct (see tcl.h).  If you change one, be sure to
  443.      * change the other.
  444.      */
  445.  
  446.     char *result;        /* Points to result returned by last
  447.                  * command. */
  448.     Tcl_FreeProc *freeProc;    /* Zero means result is statically allocated.
  449.                  * If non-zero, gives address of procedure
  450.                  * to invoke to free the result.  Must be
  451.                  * freed by Tcl_Eval before executing next
  452.                  * command. */
  453.     int errorLine;        /* When TCL_ERROR is returned, this gives
  454.                  * the line number within the command where
  455.                  * the error occurred (1 means first line). */
  456.     Tcl_HashTable commandTable;    /* Contains all of the commands currently
  457.                  * registered in this interpreter.  Indexed
  458.                  * by strings; values have type (Command *). */
  459.     Tcl_HashTable mathFuncTable;/* Contains all of the math functions currently
  460.                  * defined for the interpreter.  Indexed by
  461.                  * strings (function names);  values have
  462.                  * type (MathFunc *). */
  463.  
  464.     /*
  465.      * Information related to procedures and variables.  See tclProc.c
  466.      * and tclvar.c for usage.
  467.      */
  468.  
  469.     Tcl_HashTable globalTable;    /* Contains all global variables for
  470.                  * interpreter. */
  471.     int numLevels;        /* Keeps track of how many nested calls to
  472.                  * Tcl_Eval are in progress for this
  473.                  * interpreter.  It's used to delay deletion
  474.                  * of the table until all Tcl_Eval invocations
  475.                  * are completed. */
  476.     int maxNestingDepth;    /* If numLevels exceeds this value then Tcl
  477.                  * assumes that infinite recursion has
  478.                  * occurred and it generates an error. */
  479.     CallFrame *framePtr;    /* Points to top-most in stack of all nested
  480.                  * procedure invocations.  NULL means there
  481.                  * are no active procedures. */
  482.     CallFrame *varFramePtr;    /* Points to the call frame whose variables
  483.                  * are currently in use (same as framePtr
  484.                  * unless an "uplevel" command is being
  485.                  * executed).  NULL means no procedure is
  486.                  * active or "uplevel 0" is being exec'ed. */
  487.     ActiveVarTrace *activeTracePtr;
  488.                 /* First in list of active traces for interp,
  489.                  * or NULL if no active traces. */
  490.     int returnCode;        /* Completion code to return if current
  491.                  * procedure exits with a TCL_RETURN code. */
  492.     char *errorInfo;        /* Value to store in errorInfo if returnCode
  493.                  * is TCL_ERROR.  Malloc'ed, may be NULL */
  494.     char *errorCode;        /* Value to store in errorCode if returnCode
  495.                  * is TCL_ERROR.  Malloc'ed, may be NULL */
  496.  
  497.     /*
  498.      * Information related to history:
  499.      */
  500.  
  501.     int numEvents;        /* Number of previously-executed commands
  502.                  * to retain. */
  503.     HistoryEvent *events;    /* Array containing numEvents entries
  504.                  * (dynamically allocated). */
  505.     int curEvent;        /* Index into events of place where current
  506.                  * (or most recent) command is recorded. */
  507.     int curEventNum;        /* Event number associated with the slot
  508.                  * given by curEvent. */
  509.     HistoryRev *revPtr;        /* First in list of pending revisions. */
  510.     char *historyFirst;        /* First char. of current command executed
  511.                  * from history module or NULL if none. */
  512.     int revDisables;        /* 0 means history revision OK;  > 0 gives
  513.                  * a count of number of times revision has
  514.                  * been disabled. */
  515.     char *evalFirst;        /* If TCL_RECORD_BOUNDS flag set, Tcl_Eval
  516.                  * sets this field to point to the first
  517.                  * char. of text from which the current
  518.                  * command came.  Otherwise Tcl_Eval sets
  519.                  * this to NULL. */
  520.     char *evalLast;        /* Similar to evalFirst, except points to
  521.                  * last character of current command. */
  522.  
  523.     /*
  524.      * Information used by Tcl_AppendResult to keep track of partial
  525.      * results.  See Tcl_AppendResult code for details.
  526.      */
  527.  
  528.     char *appendResult;        /* Storage space for results generated
  529.                  * by Tcl_AppendResult.  Malloc-ed.  NULL
  530.                  * means not yet allocated. */
  531.     int appendAvl;        /* Total amount of space available at
  532.                  * partialResult. */
  533.     int appendUsed;        /* Number of non-null bytes currently
  534.                  * stored at partialResult. */
  535.  
  536.     /*
  537.      * A cache of compiled regular expressions.  See Tcl_RegExpCompile
  538.      * in tclUtil.c for details.
  539.      */
  540.  
  541. #define NUM_REGEXPS 5
  542.     char *patterns[NUM_REGEXPS];/* Strings corresponding to compiled
  543.                  * regular expression patterns.  NULL
  544.                  * means that this slot isn't used.
  545.                  * Malloc-ed. */
  546.     int patLengths[NUM_REGEXPS];/* Number of non-null characters in
  547.                  * corresponding entry in patterns.
  548.                  * -1 means entry isn't used. */
  549.     regexp *regexps[NUM_REGEXPS];
  550.                 /* Compiled forms of above strings.  Also
  551.                  * malloc-ed, or NULL if not in use yet. */
  552.  
  553.     /*
  554.      * Information used by Tcl_PrintDouble:
  555.      */
  556.  
  557.     char pdFormat[10];        /* Format string used by Tcl_PrintDouble. */
  558.     int pdPrec;            /* Current precision (used to restore the
  559.                  * the tcl_precision variable after a bogus
  560.                  * value has been put into it). */
  561.  
  562.     /*
  563.      * Miscellaneous information:
  564.      */
  565.  
  566.     int cmdCount;        /* Total number of times a command procedure
  567.                  * has been called for this interpreter. */
  568.     int noEval;            /* Non-zero means no commands should actually
  569.                  * be executed:  just parse only.  Used in
  570.                  * expressions when the result is already
  571.                  * determined. */
  572.     int evalFlags;        /* Flags to control next call to Tcl_Eval.
  573.                  * Normally zero, but may be set before
  574.                  * calling Tcl_Eval.  See below for valid
  575.                  * values. */
  576.     char *termPtr;        /* Character just after the last one in
  577.                  * a command.  Set by Tcl_Eval before
  578.                  * returning. */
  579.     char *scriptFile;        /* NULL means there is no nested source
  580.                  * command active;  otherwise this points to
  581.                  * the name of the file being sourced (it's
  582.                  * not malloc-ed:  it points to an argument
  583.                  * to Tcl_EvalFile. */
  584.     int flags;            /* Various flag bits.  See below. */
  585.     Trace *tracePtr;        /* List of traces for this interpreter. */
  586.     DeleteCallback *deleteCallbackPtr;
  587.                 /* First in list of callbacks to invoke when
  588.                  * interpreter is deleted. */
  589.     char resultSpace[TCL_RESULT_SIZE+1];
  590.                 /* Static space for storing small results. */
  591. } Interp;
  592.  
  593. /*
  594.  * EvalFlag bits for Interp structures:
  595.  *
  596.  * TCL_BRACKET_TERM    1 means that the current script is terminated by
  597.  *            a close bracket rather than the end of the string.
  598.  * TCL_RECORD_BOUNDS    Tells Tcl_Eval to record information in the
  599.  *            evalFirst and evalLast fields for each command
  600.  *            executed directly from the string (top-level
  601.  *            commands and those from command substitution).
  602.  * TCL_ALLOW_EXCEPTIONS    1 means it's OK for the script to terminate with
  603.  *            a code other than TCL_OK or TCL_ERROR;  0 means
  604.  *            codes other than these should be turned into errors.
  605.  */
  606.  
  607. #define TCL_BRACKET_TERM    1
  608. #define TCL_RECORD_BOUNDS    2
  609. #define TCL_ALLOW_EXCEPTIONS    4
  610.  
  611. /*
  612.  * Flag bits for Interp structures:
  613.  *
  614.  * DELETED:        Non-zero means the interpreter has been deleted:
  615.  *            don't process any more commands for it, and destroy
  616.  *            the structure as soon as all nested invocations of
  617.  *            Tcl_Eval are done.
  618.  * ERR_IN_PROGRESS:    Non-zero means an error unwind is already in progress.
  619.  *            Zero means a command proc has been invoked since last
  620.  *            error occured.
  621.  * ERR_ALREADY_LOGGED:    Non-zero means information has already been logged
  622.  *            in $errorInfo for the current Tcl_Eval instance,
  623.  *            so Tcl_Eval needn't log it (used to implement the
  624.  *            "error message log" command).
  625.  * ERROR_CODE_SET:    Non-zero means that Tcl_SetErrorCode has been
  626.  *            called to record information for the current
  627.  *            error.  Zero means Tcl_Eval must clear the
  628.  *            errorCode variable if an error is returned.
  629.  * EXPR_INITIALIZED:    1 means initialization specific to expressions has
  630.  *            been carried out.
  631.  */
  632.  
  633. #define DELETED            1
  634. #define ERR_IN_PROGRESS        2
  635. #define ERR_ALREADY_LOGGED    4
  636. #define ERROR_CODE_SET        8
  637. #define EXPR_INITIALIZED    0x10
  638.  
  639. /*
  640.  * Default value for the pdPrec and pdFormat fields of interpreters:
  641.  */
  642.  
  643. #define DEFAULT_PD_PREC 6
  644. #define DEFAULT_PD_FORMAT "%g"
  645.  
  646. /*
  647.  *----------------------------------------------------------------
  648.  * Data structures related to command parsing.   These are used in
  649.  * tclParse.c and its clients.
  650.  *----------------------------------------------------------------
  651.  */
  652.  
  653. /*
  654.  * The following data structure is used by various parsing procedures
  655.  * to hold information about where to store the results of parsing
  656.  * (e.g. the substituted contents of a quoted argument, or the result
  657.  * of a nested command).  At any given time, the space available
  658.  * for output is fixed, but a procedure may be called to expand the
  659.  * space available if the current space runs out.
  660.  */
  661.  
  662. typedef struct ParseValue {
  663.     char *buffer;        /* Address of first character in
  664.                  * output buffer. */
  665.     char *next;            /* Place to store next character in
  666.                  * output buffer. */
  667.     char *end;            /* Address of the last usable character
  668.                  * in the buffer. */
  669.     void (*expandProc) _ANSI_ARGS_((struct ParseValue *pvPtr, int needed));
  670.                 /* Procedure to call when space runs out;
  671.                  * it will make more space. */
  672.     ClientData clientData;    /* Arbitrary information for use of
  673.                  * expandProc. */
  674. } ParseValue;
  675.  
  676. /*
  677.  * A table used to classify input characters to assist in parsing
  678.  * Tcl commands.  The table should be indexed with a signed character
  679.  * using the CHAR_TYPE macro.  The character may have a negative
  680.  * value.
  681.  */
  682.  
  683. extern char tclTypeTable[];
  684. #define CHAR_TYPE(c) (tclTypeTable+128)[c]
  685.  
  686. /*
  687.  * Possible values returned by CHAR_TYPE:
  688.  *
  689.  * TCL_NORMAL -        All characters that don't have special significance
  690.  *            to the Tcl language.
  691.  * TCL_SPACE -        Character is space, tab, or return.
  692.  * TCL_COMMAND_END -    Character is newline or null or semicolon or
  693.  *            close-bracket.
  694.  * TCL_QUOTE -        Character is a double-quote.
  695.  * TCL_OPEN_BRACKET -    Character is a "[".
  696.  * TCL_OPEN_BRACE -    Character is a "{".
  697.  * TCL_CLOSE_BRACE -    Character is a "}".
  698.  * TCL_BACKSLASH -    Character is a "\".
  699.  * TCL_DOLLAR -        Character is a "$".
  700.  */
  701.  
  702. #define TCL_NORMAL        0
  703. #define TCL_SPACE        1
  704. #define TCL_COMMAND_END        2
  705. #define TCL_QUOTE        3
  706. #define TCL_OPEN_BRACKET    4
  707. #define TCL_OPEN_BRACE        5
  708. #define TCL_CLOSE_BRACE        6
  709. #define TCL_BACKSLASH        7
  710. #define TCL_DOLLAR        8
  711.  
  712. /*
  713.  * Maximum number of levels of nesting permitted in Tcl commands (used
  714.  * to catch infinite recursion).
  715.  */
  716.  
  717. #define MAX_NESTING_DEPTH    1000
  718.  
  719. /*
  720.  * The macro below is used to modify a "char" value (e.g. by casting
  721.  * it to an unsigned character) so that it can be used safely with
  722.  * macros such as isspace.
  723.  */
  724.  
  725. #define UCHAR(c) ((unsigned char) (c))
  726.  
  727. /*
  728.  * Given a size or address, the macro below "aligns" it to the machine's
  729.  * memory unit size (e.g. an 8-byte boundary) so that anything can be
  730.  * placed at the aligned address without fear of an alignment error.
  731.  */
  732.  
  733. #define TCL_ALIGN(x) ((x + 7) & ~7)
  734.  
  735. /*
  736.  * Variables shared among Tcl modules but not used by the outside
  737.  * world:
  738.  */
  739.  
  740. extern int        tclNumFiles;
  741. extern OpenFile **    tclOpenFiles;
  742.  
  743. /*
  744.  *----------------------------------------------------------------
  745.  * Procedures shared among Tcl modules but not used by the outside
  746.  * world:
  747.  *----------------------------------------------------------------
  748.  */
  749.  
  750. extern void        panic();
  751. extern void        TclCopyAndCollapse _ANSI_ARGS_((int count, char *src,
  752.                 char *dst));
  753. extern void        TclDeleteVars _ANSI_ARGS_((Interp *iPtr,
  754.                 Tcl_HashTable *tablePtr));
  755. extern void        TclExpandParseValue _ANSI_ARGS_((ParseValue *pvPtr,
  756.                 int needed));
  757. extern void        TclExprFloatError _ANSI_ARGS_((Tcl_Interp *interp,
  758.                 double value));
  759. extern int        TclFindElement _ANSI_ARGS_((Tcl_Interp *interp,
  760.                 char *list, char **elementPtr, char **nextPtr,
  761.                 int *sizePtr, int *bracePtr));
  762. extern Proc *        TclFindProc _ANSI_ARGS_((Interp *iPtr,
  763.                 char *procName));
  764. extern int        TclGetFrame _ANSI_ARGS_((Tcl_Interp *interp,
  765.                 char *string, CallFrame **framePtrPtr));
  766. extern int        TclGetListIndex _ANSI_ARGS_((Tcl_Interp *interp,
  767.                 char *string, int *indexPtr));
  768. extern Proc *        TclIsProc _ANSI_ARGS_((Command *cmdPtr));
  769. extern int        TclNeedSpace _ANSI_ARGS_((char *start, char *end));
  770. extern int        TclParseBraces _ANSI_ARGS_((Tcl_Interp *interp,
  771.                 char *string, char **termPtr, ParseValue *pvPtr));
  772. extern int        TclParseNestedCmd _ANSI_ARGS_((Tcl_Interp *interp,
  773.                 char *string, int flags, char **termPtr,
  774.                 ParseValue *pvPtr));
  775. extern int        TclParseQuotes _ANSI_ARGS_((Tcl_Interp *interp,
  776.                 char *string, int termChar, int flags,
  777.                 char **termPtr, ParseValue *pvPtr));
  778. extern int        TclParseWords _ANSI_ARGS_((Tcl_Interp *interp,
  779.                 char *string, int flags, int maxWords,
  780.                 char **termPtr, int *argcPtr, char **argv,
  781.                 ParseValue *pvPtr));
  782. extern char *        TclPrecTraceProc _ANSI_ARGS_((ClientData clientData,
  783.                 Tcl_Interp *interp, char *name1, char *name2,
  784.                 int flags));
  785. extern void        TclSetupEnv _ANSI_ARGS_((Tcl_Interp *interp));
  786. extern int        TclUpdateReturnInfo _ANSI_ARGS_((Interp *iPtr));
  787. extern char *        TclWordEnd _ANSI_ARGS_((char *start, int nested,
  788.                 int *semiPtr));
  789.  
  790. /*
  791.  *----------------------------------------------------------------
  792.  * Command procedures in the generic core:
  793.  *----------------------------------------------------------------
  794.  */
  795.  
  796. extern int    Tcl_AppendCmd _ANSI_ARGS_((ClientData clientData,
  797.             Tcl_Interp *interp, int argc, char **argv));
  798. extern int    Tcl_ArrayCmd _ANSI_ARGS_((ClientData clientData,
  799.             Tcl_Interp *interp, int argc, char **argv));
  800. extern int    Tcl_BreakCmd _ANSI_ARGS_((ClientData clientData,
  801.             Tcl_Interp *interp, int argc, char **argv));
  802. extern int    Tcl_CaseCmd _ANSI_ARGS_((ClientData clientData,
  803.             Tcl_Interp *interp, int argc, char **argv));
  804. extern int    Tcl_CatchCmd _ANSI_ARGS_((ClientData clientData,
  805.             Tcl_Interp *interp, int argc, char **argv));
  806. extern int    Tcl_ConcatCmd _ANSI_ARGS_((ClientData clientData,
  807.             Tcl_Interp *interp, int argc, char **argv));
  808. extern int    Tcl_ContinueCmd _ANSI_ARGS_((ClientData clientData,
  809.             Tcl_Interp *interp, int argc, char **argv));
  810. extern int    Tcl_ErrorCmd _ANSI_ARGS_((ClientData clientData,
  811.             Tcl_Interp *interp, int argc, char **argv));
  812. extern int    Tcl_EvalCmd _ANSI_ARGS_((ClientData clientData,
  813.             Tcl_Interp *interp, int argc, char **argv));
  814. extern int    Tcl_ExprCmd _ANSI_ARGS_((ClientData clientData,
  815.             Tcl_Interp *interp, int argc, char **argv));
  816. extern int    Tcl_ForCmd _ANSI_ARGS_((ClientData clientData,
  817.             Tcl_Interp *interp, int argc, char **argv));
  818. extern int    Tcl_ForeachCmd _ANSI_ARGS_((ClientData clientData,
  819.             Tcl_Interp *interp, int argc, char **argv));
  820. extern int    Tcl_FormatCmd _ANSI_ARGS_((ClientData clientData,
  821.             Tcl_Interp *interp, int argc, char **argv));
  822. extern int    Tcl_GlobalCmd _ANSI_ARGS_((ClientData clientData,
  823.             Tcl_Interp *interp, int argc, char **argv));
  824. extern int    Tcl_HistoryCmd _ANSI_ARGS_((ClientData clientData,
  825.             Tcl_Interp *interp, int argc, char **argv));
  826. extern int    Tcl_IfCmd _ANSI_ARGS_((ClientData clientData,
  827.             Tcl_Interp *interp, int argc, char **argv));
  828. extern int    Tcl_IncrCmd _ANSI_ARGS_((ClientData clientData,
  829.             Tcl_Interp *interp, int argc, char **argv));
  830. extern int    Tcl_InfoCmd _ANSI_ARGS_((ClientData clientData,
  831.             Tcl_Interp *interp, int argc, char **argv));
  832. extern int    Tcl_JoinCmd _ANSI_ARGS_((ClientData clientData,
  833.             Tcl_Interp *interp, int argc, char **argv));
  834. extern int    Tcl_LappendCmd _ANSI_ARGS_((ClientData clientData,
  835.             Tcl_Interp *interp, int argc, char **argv));
  836. extern int    Tcl_LindexCmd _ANSI_ARGS_((ClientData clientData,
  837.             Tcl_Interp *interp, int argc, char **argv));
  838. extern int    Tcl_LinsertCmd _ANSI_ARGS_((ClientData clientData,
  839.             Tcl_Interp *interp, int argc, char **argv));
  840. extern int    Tcl_LlengthCmd _ANSI_ARGS_((ClientData clientData,
  841.             Tcl_Interp *interp, int argc, char **argv));
  842. extern int    Tcl_ListCmd _ANSI_ARGS_((ClientData clientData,
  843.             Tcl_Interp *interp, int argc, char **argv));
  844. extern int    Tcl_LrangeCmd _ANSI_ARGS_((ClientData clientData,
  845.             Tcl_Interp *interp, int argc, char **argv));
  846. extern int    Tcl_LreplaceCmd _ANSI_ARGS_((ClientData clientData,
  847.             Tcl_Interp *interp, int argc, char **argv));
  848. extern int    Tcl_LsearchCmd _ANSI_ARGS_((ClientData clientData,
  849.             Tcl_Interp *interp, int argc, char **argv));
  850. extern int    Tcl_LsortCmd _ANSI_ARGS_((ClientData clientData,
  851.             Tcl_Interp *interp, int argc, char **argv));
  852. extern int    Tcl_ProcCmd _ANSI_ARGS_((ClientData clientData,
  853.             Tcl_Interp *interp, int argc, char **argv));
  854. extern int    Tcl_RegexpCmd _ANSI_ARGS_((ClientData clientData,
  855.             Tcl_Interp *interp, int argc, char **argv));
  856. extern int    Tcl_RegsubCmd _ANSI_ARGS_((ClientData clientData,
  857.             Tcl_Interp *interp, int argc, char **argv));
  858. extern int    Tcl_RenameCmd _ANSI_ARGS_((ClientData clientData,
  859.             Tcl_Interp *interp, int argc, char **argv));
  860. extern int    Tcl_ReturnCmd _ANSI_ARGS_((ClientData clientData,
  861.             Tcl_Interp *interp, int argc, char **argv));
  862. extern int    Tcl_ScanCmd _ANSI_ARGS_((ClientData clientData,
  863.             Tcl_Interp *interp, int argc, char **argv));
  864. extern int    Tcl_SetCmd _ANSI_ARGS_((ClientData clientData,
  865.             Tcl_Interp *interp, int argc, char **argv));
  866. extern int    Tcl_SplitCmd _ANSI_ARGS_((ClientData clientData,
  867.             Tcl_Interp *interp, int argc, char **argv));
  868. extern int    Tcl_StringCmd _ANSI_ARGS_((ClientData clientData,
  869.             Tcl_Interp *interp, int argc, char **argv));
  870. extern int    Tcl_SubstCmd _ANSI_ARGS_((ClientData clientData,
  871.             Tcl_Interp *interp, int argc, char **argv));
  872. extern int    Tcl_SwitchCmd _ANSI_ARGS_((ClientData clientData,
  873.             Tcl_Interp *interp, int argc, char **argv));
  874. extern int    Tcl_TraceCmd _ANSI_ARGS_((ClientData clientData,
  875.             Tcl_Interp *interp, int argc, char **argv));
  876. extern int    Tcl_UnsetCmd _ANSI_ARGS_((ClientData clientData,
  877.             Tcl_Interp *interp, int argc, char **argv));
  878. extern int    Tcl_UplevelCmd _ANSI_ARGS_((ClientData clientData,
  879.             Tcl_Interp *interp, int argc, char **argv));
  880. extern int    Tcl_UpvarCmd _ANSI_ARGS_((ClientData clientData,
  881.             Tcl_Interp *interp, int argc, char **argv));
  882. extern int    Tcl_WhileCmd _ANSI_ARGS_((ClientData clientData,
  883.             Tcl_Interp *interp, int argc, char **argv));
  884. extern int    Tcl_Cmd _ANSI_ARGS_((ClientData clientData,
  885.             Tcl_Interp *interp, int argc, char **argv));
  886. extern int    Tcl_Cmd _ANSI_ARGS_((ClientData clientData,
  887.             Tcl_Interp *interp, int argc, char **argv));
  888.  
  889. /*
  890.  *----------------------------------------------------------------
  891.  * Command procedures in the UNIX core:
  892.  *----------------------------------------------------------------
  893.  */
  894.  
  895. extern int    Tcl_CdCmd _ANSI_ARGS_((ClientData clientData,
  896.             Tcl_Interp *interp, int argc, char **argv));
  897. extern int    Tcl_CloseCmd _ANSI_ARGS_((ClientData clientData,
  898.             Tcl_Interp *interp, int argc, char **argv));
  899. extern int    Tcl_EofCmd _ANSI_ARGS_((ClientData clientData,
  900.             Tcl_Interp *interp, int argc, char **argv));
  901. extern int    Tcl_ExecCmd _ANSI_ARGS_((ClientData clientData,
  902.             Tcl_Interp *interp, int argc, char **argv));
  903. extern int    Tcl_ExitCmd _ANSI_ARGS_((ClientData clientData,
  904.             Tcl_Interp *interp, int argc, char **argv));
  905. extern int    Tcl_FileCmd _ANSI_ARGS_((ClientData clientData,
  906.             Tcl_Interp *interp, int argc, char **argv));
  907. extern int    Tcl_FlushCmd _ANSI_ARGS_((ClientData clientData,
  908.             Tcl_Interp *interp, int argc, char **argv));
  909. extern int    Tcl_GetsCmd _ANSI_ARGS_((ClientData clientData,
  910.             Tcl_Interp *interp, int argc, char **argv));
  911. extern int    Tcl_GlobCmd _ANSI_ARGS_((ClientData clientData,
  912.             Tcl_Interp *interp, int argc, char **argv));
  913. extern int    Tcl_OpenCmd _ANSI_ARGS_((ClientData clientData,
  914.             Tcl_Interp *interp, int argc, char **argv));
  915. extern int    Tcl_PutsCmd _ANSI_ARGS_((ClientData clientData,
  916.             Tcl_Interp *interp, int argc, char **argv));
  917. extern int    Tcl_PidCmd _ANSI_ARGS_((ClientData clientData,
  918.             Tcl_Interp *interp, int argc, char **argv));
  919. extern int    Tcl_PwdCmd _ANSI_ARGS_((ClientData clientData,
  920.             Tcl_Interp *interp, int argc, char **argv));
  921. extern int    Tcl_ReadCmd _ANSI_ARGS_((ClientData clientData,
  922.             Tcl_Interp *interp, int argc, char **argv));
  923. extern int    Tcl_SeekCmd _ANSI_ARGS_((ClientData clientData,
  924.             Tcl_Interp *interp, int argc, char **argv));
  925. extern int    Tcl_SourceCmd _ANSI_ARGS_((ClientData clientData,
  926.             Tcl_Interp *interp, int argc, char **argv));
  927. extern int    Tcl_TellCmd _ANSI_ARGS_((ClientData clientData,
  928.             Tcl_Interp *interp, int argc, char **argv));
  929. extern int    Tcl_TimeCmd _ANSI_ARGS_((ClientData clientData,
  930.             Tcl_Interp *interp, int argc, char **argv));
  931.  
  932. #endif /* _TCLINT */
  933.